@lion/overlays

Overlays System

🛠 Status: Pilot Phase

Lion Web Components are still in an early alpha stage; they should not be considered production ready yet.

The goal of our pilot phase is to gather feedback from a private group of users. Therefore, during this phase, we kindly ask you to:

• not publicly promote or link us yet: (no tweets, blog posts or other forms of communication about Lion Web Components)
• not publicly promote or link products derived from/based on Lion Web Components

As soon as Pilot Phase ends we will let you know (feel free to subscribe to this issue https://github.com/ing-bank/lion/issues/1)

Supports different types of overlays like dialogs, toasts, tooltips, dropdown, etc... Manages their position on the screen relative to other elements, including other overlays.

Features

• Overlays Manager, a global repository keeping track of all different types of overlays.
• Overlays Occurrences, outline of all possible occurrences of overlays. Divided into two main types:
  • Global Overlay Controller, controller for overlays relative to the viewport.
  • Local Overlay Controller, controller for overlays positioned next to invokers they are related to.

How to use

Installation

npm i --save @lion/overlays

Example

import { overlays } from '@lion/overlays';

const myCtrl = overlays.add(
  new OverlayTypeController({
    /* options */
  }),
);
// name OverlayTypeController is for illustration purpose only
// please read below about existing classes for different types of overlays